/*
 * File : StoredProcedureWork.java.java
 * Date : Sep 29, 2010
 * 
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2008 The KiWi Project. All rights reserved.
 * http://www.kiwi-project.eu
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common
 * Development and Distribution License("CDDL") (collectively, the
 * "License"). You may not use this file except in compliance with the
 * License. You can obtain a copy of the License at
 * http://www.netbeans.org/cddl-gplv2.html
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 * specific language governing permissions and limitations under the
 * License.  When distributing the software, include this License Header
 * Notice in each file and include the License file at
 * nbbuild/licenses/CDDL-GPL-2-CP.  KiWi designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Sun in the GPL Version 2 section of the License file that
 * accompanied this code. If applicable, add the following below the
 * License Header, with the fields enclosed by brackets [] replaced by
 * your own identifying information:
 * "Portions Copyrighted [year] [name of copyright owner]"
 *
 * If you wish your version of this file to be governed by only the CDDL
 * or only the GPL Version 2, indicate your decision by adding
 * "[Contributor] elects to include this software in this distribution
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 * single choice of license, a recipient has the option to distribute
 * your version of this file under either the CDDL, the GPL Version 2 or
 * to extend the choice of license to its licensees as provided above.
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 * Version 2 license, then the option applies only if the new code is
 * made subject to such option by the copyright holder.
 *
 * Contributor(s):
 */


package kiwi.core.service.equity;


import java.sql.Connection;
import java.sql.SQLException;
import java.sql.Statement;

import org.hibernate.jdbc.Work;


/**
 * @author Mihai
 * @version 0.9
 * @since 0.9
 */
public final class StoredProcedureWork implements Work {

    /**
     * The SQL statement to execute.
     */
    private final String sqlStatement;

    /**
     * Builds an <code>StoredProcedureWork</code> for a given SQL
     * statement.
     * 
     * @param sqlStatement the SQL statement to execute, it can
     *            not be null.
     * @throws NullPointerException if the sqlStatement argument
     *             is null.
     */
    public StoredProcedureWork(String sqlStatement) {
        if (sqlStatement == null) {
            throw new NullPointerException("The sqlStatement is null.");
        }

        this.sqlStatement = sqlStatement;
    }

    /**
     * Builds an <code>java.sql.Statement</code> and execute it
     * on the given connection.
     * 
     * @param connection the JDBC connection where the
     *            <code>java.sql.Statement</code> will be
     *            executed.
     * @throws SQLException by any SQL related exception.
     */
    @Override
    public void execute(Connection connection) throws SQLException {
        final Statement statement = connection.createStatement();
        statement.executeUpdate(sqlStatement);
    }

    /**
     * The String representation for this worker.
     * 
     * @return the String representation for this worker.
     */
    @Override
    public String toString() {
        return "StoredProcedureWork [sqlStatement=" + sqlStatement + "]";
    }

}
